LinuxQMISDK  SLQS04.00.27
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Enumerations | Functions
qaGobiApiFms.h File Reference
Firmware Management Service (FMS)

Firmware Management Service API function prototypes. More...

Go to the source code of this file.

Data Structures

struct  fwinfo_s
 
struct  slqsfwinfo_s
 
struct  slqsfwpartno_s
 
struct  qmifwinfo_s
 
struct  firmwarefileinfo_s
 
struct  ImageElement
 
struct  PrefImageList
 
struct  ImageIdElement
 
struct  ImageIDEntries
 
struct  ImageList
 
struct  sGetDeviceSeriesResult
 
struct  SWI_STRUCT_CarrierImage
 
struct  CurrImageInfo
 
struct  CurrentImgList
 

Macros

#define SLQSFWINFO_MODELID_SZ   20
 
#define SLQSFWINFO_BOOTVERSION_SZ   85
 
#define SLQSFWINFO_APPVERSION_SZ   85
 
#define SLQSFWINFO_SKU_SZ   15
 
#define SLQSFWINFO_PACKAGEID_SZ   85
 
#define SLQSFWINFO_CARRIER_SZ   20
 
#define SLQSFWINFO_PRIVERSION_SZ   16
 
#define SLQSFWINFO_CUR_CARR_NAME   17
 
#define SLQSFWINFO_CUR_CARR_REV   13
 
#define SLQSFWINFO_PART_NO_SZ   15
 
#define GOBI_MBN_IMG_ID_SIZE   16
 
#define TOTAL_IMAGE_ID_STRING_SIZE   100
 
#define GOBI_MBN_IMG_ID_STR_LEN   TOTAL_IMAGE_ID_STRING_SIZE
 
#define GOBI_MBN_BUILD_ID_STR_LEN   TOTAL_IMAGE_ID_STRING_SIZE
 
#define GOBI_LISTENTRIES_MAX   2
 
#define GOBI_SET_IMG_PREF_RSPLEN   40
 
#define DEVICE_SHUTDOWN   5
 
#define DEVICE_RESET   4
 
#define DEVICE_OFFLINE   3
 
#define FIRMWARE_UPDATE_SUCCESS   0x01
 
#define FIRMWARE_UPDATE_FAIL   0x01
 
#define PRI_UPDATE_FAIL   0x02
 
#define FIRMWARE_UPGRADE_SUCCESS   0x00
 
#define IMG_ID_LEN   TOTAL_IMAGE_ID_STRING_SIZE
 
#define BUILD_ID_LEN   TOTAL_IMAGE_ID_STRING_SIZE
 
#define G3K_FIRMWARE_DOWNLOAD   1
 
#define SPKG_FIRMWARE_DOWNLOAD   2
 
#define UNIQUE_ID_LEN   16
 
#define BUILD_ID_MAX_LEN   255
 
#define IMGDETAILS_LEN   16
 
#define MAX_IMAGE_IDE_ELEMENTS   50
 
#define FMS_IMAGE_PATH_MAX_SZ   512
 
#define SLQSIMINFO_MAX_SZ   20
 
#define SLQSBCHVERSTRSIZE   84 /* size of download file's version name string */
 
#define SLQSBCHDATESIZE   8 /* size of release data string */
 

Enumerations

enum  EFileImgType {
  EFILE_TYPE_NONE = 0,
  EFILE_TYPE_CAR_PRI,
  EFILE_TYPE_OEM_PRI,
  EFILE_TYPE_COMPO_PRI
}
 
enum  EImageType {
  EIMAGE_TYPE_MIN = 0,
  EIMAGE_TYPE_BOOT = EIMAGE_TYPE_MIN,
  EIMAGE_TYPE_APPL,
  EIMAGE_TYPE_APPS,
  EIMAGE_TYPE_FILE,
  EIMAGE_TYPE_SPKG,
  EIMAGE_TYPE_MODM,
  EIMAGE_TYPE_USER,
  EIMAGE_TYPE_KEYS,
  EIMAGE_TYPE_MAX,
  EIMAGE_TYPE_INVALID = 0xFF,
  EIMAGE_TYPE_ANY = EIMAGE_TYPE_INVALID
}
 
enum  eGobiImageTech {
  eGOBI_IMG_TECH_CDMA = 0,
  eGOBI_IMG_TECH_UMTS
}
 
enum  eGobiImageCarrier {
  eGOBI_IMG_CAR_GENERIC = 1,
  eGOBI_IMG_CAR_FACTORY,
  eGOBI_IMG_CAR_NORF,
  eGOBI_IMG_CAR_VERIZON = 101,
  eGOBI_IMG_CAR_SPRINT,
  eGOBI_IMG_CAR_ALLTEL,
  eGOBI_IMG_CAR_BELL,
  eGOBI_IMG_CAR_TELUS,
  eGOBI_IMG_CAR_US,
  eGOBI_IMG_CAR_TELSTRA1,
  eGOBI_IMG_CAR_CHINA_UNICOM,
  eGOBI_IMG_CAR_TELCOM_NZ,
  eGOBI_IMG_CAR_SK_TELCOM1,
  eGOBI_IMG_CAR_RELIANCE1,
  eGOBI_IMG_CAR_TATA,
  eGOBI_IMG_CAR_METROPCS,
  eGOBI_IMG_CAR_LEAP,
  eGOBI_IMG_CAR_KDDI,
  eGOBI_IMG_CAR_IUSACELL,
  eGOBI_IMG_CAR_CHINA_TELECOM,
  eGOBI_IMG_CAR_OMH,
  eGOBI_IMG_CAR_GENERIC_CDMA,
  eGOBI_IMG_CAR_ATT = 201,
  eGOBI_IMG_CAR_VODAFONE,
  eGOBI_IMG_CAR_TMOBILE,
  eGOBI_IMG_CAR_ORANGE,
  eGOBI_IMG_CAR_TELEFONICA,
  eGOBI_IMG_CAR_TELCOM_ITALIA,
  eGOBI_IMG_CAR_3,
  eGOBI_IMG_CAR_O2,
  eGOBI_IMG_CAR_SFR,
  eGOBI_IMG_CAR_SWISSCOM,
  eGOBI_IMG_CAR_CHINA_MOBILE,
  eGOBI_IMG_CAR_TELSTRA2,
  eGOBI_IMG_CAR_SINGTEL_OPTUS,
  eGOBI_IMG_CAR_RELIANCE2,
  eGOBI_IMG_CAR_BHARTI,
  eGOBI_IMG_CAR_NTT_DOCOMO,
  eGOBI_IMG_CAR_EMOBILE,
  eGOBI_IMG_CAR_SOFTBANK,
  eGOBI_IMG_CAR_KT_FREETEL,
  eGOBI_IMG_CAR_SK_TELCOM2,
  eGOBI_IMG_CAR_TELENOR,
  eGOBI_IMG_CAR_NETCOM,
  eGOBI_IMG_CAR_TELIASONERA,
  eGOBI_IMG_CAR_AMX_TELCEL,
  eGOBI_IMG_CAR_BRASIL_VIVO,
  eGOBI_IMG_CAR_AERIS,
  eGOBI_IMG_CAR_ROGERS
}
 
enum  eGobiImageRegion {
  eGOBI_IMG_REG_NA = 0,
  eGOBI_IMG_REG_LA,
  eGOBI_IMG_REG_EU,
  eGOBI_IMG_REG_ASIA,
  eGOBI_IMG_REG_AUS,
  eGOBI_IMG_REG_GLOBAL
}
 
enum  eGobiImageGPS {
  eGOBI_IMG_GPS_NONE = 0,
  eGOBI_IMG_GPS_STAND_ALONE,
  eGOBI_IMG_GPS_ASSISTED,
  eGOBI_IMG_GPS_NO_XTRA
}
 
enum  eGobiDeviceSeries {
  eGOBI_DEV_SERIES_UNKNOWN = -1,
  eGOBI_DEV_SERIES_NON_GOBI = 0,
  eGOBI_DEV_SERIES_G3K,
  eGOBI_DEV_SERIES_SIERRA_GOBI,
  eGOBI_DEV_SERIES_9X15,
  eGOBI_DEV_SERIES_9X30,
  eGOBI_DEV_SERIES_9X07_9X50,
  eGOBI_DEV_SERIES_9X05,
  eGobi_DEV_SERIES_MC83
}
 

Functions

ULONG GetImageStore (WORD imageStorePathSize, CHAR *pImageStorePath)
 
ULONG SLQSGetFirmwareInfo (struct qmifwinfo_s *pinfo)
 
ULONG SLQSGetImageInfoMC77xx (LPCSTR path, struct qmifwinfo_s *pinfo)
 
ULONG SLQSGetImageInfoMC83xx (LPCSTR path, struct qmifwinfo_s *pinfo)
 
ULONG SLQSGetImageInfo (LPCSTR path, struct qmifwinfo_s *pinfo)
 
ULONG SLQSGetImagePartNumber (LPCSTR path, BYTE imgType, struct slqsfwpartno_s *pinfo)
 
ULONG UpgradeFirmware2k (CHAR *pDestinationPath)
 
ULONG GetImagesPreference (ULONG *pImageListSize, struct PrefImageList *pImageList)
 
ULONG SetImagesPreference (ULONG imageListSize, BYTE *pImageList, ULONG bForceDownload, BYTE modemIndex, ULONG *pImageTypesSize, BYTE *pImageTypes)
 
ULONG GetStoredImages (ULONG *pImageListSize, BYTE *pImageList)
 
ULONG DeleteStoredImage (ULONG imageInfoSize, BYTE *pImageInfo)
 
ULONG SLQSGetImageInfo_9x15 (LPCSTR path, BYTE imgType, struct slqsfwinfo_s *pinfo)
 
ULONG SLQSUpgradeFirmware9x07 (CHAR *pDestinationPath)
 
ULONG SLQSUpgradeFirmware9x15 (CHAR *pDestinationPath)
 
ULONG SLQSGetBootVersionNumber (ULONG *bootversion)
 
BOOL SLQSIsSpkgFormatRequired (void)
 
void SLQSSetSpkgFormatRequired (BYTE isneeded)
 
ULONG upgrade_mc77xx_fw (LPCSTR path)
 
void eGetDeviceSeries (struct sGetDeviceSeriesResult *)
 
ULONG SLQSSwiGetAllCarrierImages (ULONG *pNumOfItems, struct SWI_STRUCT_CarrierImage *pCarrierImages, char *pFolderPath)
 
ULONG DownloadToSlot (CHAR *path, struct slqsfwinfo_s fwImgInfo, struct slqsfwinfo_s priImgInfo, BYTE slot, BYTE forceDownload)
 
ULONG SLQSDownloadFirmwareToSlot (CHAR *pPath, BYTE slot_index, BYTE force_download)
 
ULONG SLQSGetValidFwPriCombinations (struct ImageList *pStoredImageList, ULONG *pValidCombinationSize, struct SWI_STRUCT_CarrierImage *pValidCombinations)
 
ULONG SLQSSetSIMBasedImageSwitching (void)
 
void SLQSSetCrashStateCheckIgnore (BOOL ignore)
 
ULONG SLQSSwiGetFirmwareCurr (CurrentImgList *pCurrentImgList)
 
ULONG upgrade_9x07_9x50_fw (LPCSTR path)
 
ULONG SetImagePath (CHAR *path, ULONG isMDM9x15, WORD imgMask, BYTE mdmProtocol)
 
int SLQSIsBootloaderDebugEnabled (const char *szPath, const char *pQsn)
 
ULONG SLQSGetFirmwareFileInfo (CHAR *pPath, struct firmwarefileinfo_s *pInfo, BYTE *pNumOfItems)
 

Detailed Description

Firmware Management Service API function prototypes.

Macro Definition Documentation

#define BUILD_ID_LEN   TOTAL_IMAGE_ID_STRING_SIZE
#define BUILD_ID_MAX_LEN   255
#define DEVICE_OFFLINE   3
#define DEVICE_RESET   4
#define DEVICE_SHUTDOWN   5
#define FIRMWARE_UPDATE_FAIL   0x01
#define FIRMWARE_UPDATE_SUCCESS   0x01
#define FIRMWARE_UPGRADE_SUCCESS   0x00
#define FMS_IMAGE_PATH_MAX_SZ   512
#define G3K_FIRMWARE_DOWNLOAD   1
#define GOBI_LISTENTRIES_MAX   2
#define GOBI_MBN_BUILD_ID_STR_LEN   TOTAL_IMAGE_ID_STRING_SIZE
#define GOBI_MBN_IMG_ID_SIZE   16
#define GOBI_MBN_IMG_ID_STR_LEN   TOTAL_IMAGE_ID_STRING_SIZE
#define GOBI_SET_IMG_PREF_RSPLEN   40
#define IMG_ID_LEN   TOTAL_IMAGE_ID_STRING_SIZE
#define IMGDETAILS_LEN   16
#define MAX_IMAGE_IDE_ELEMENTS   50
#define PRI_UPDATE_FAIL   0x02
#define SLQSBCHDATESIZE   8 /* size of release data string */
#define SLQSBCHVERSTRSIZE   84 /* size of download file's version name string */
#define SLQSFWINFO_APPVERSION_SZ   85
#define SLQSFWINFO_BOOTVERSION_SZ   85
#define SLQSFWINFO_CARRIER_SZ   20
#define SLQSFWINFO_CUR_CARR_NAME   17
#define SLQSFWINFO_CUR_CARR_REV   13
#define SLQSFWINFO_MODELID_SZ   20

Copyright: © 2011-2020 Sierra Wireless, Inc. all rights reserved

#define SLQSFWINFO_PACKAGEID_SZ   85
#define SLQSFWINFO_PART_NO_SZ   15
#define SLQSFWINFO_PRIVERSION_SZ   16
#define SLQSFWINFO_SKU_SZ   15
#define SLQSIMINFO_MAX_SZ   20
#define SPKG_FIRMWARE_DOWNLOAD   2
#define TOTAL_IMAGE_ID_STRING_SIZE   100
#define UNIQUE_ID_LEN   16

Enumeration Type Documentation

enum EFileImgType

Name: EFileImgType

Purpose: Enumerate different PRI type

Members: eFILE_TYPE_NONE - Start of list eFILE_TYPE_CAR_PRI - Carrier PRI file (file name starts with “9999999_”) eFILE_TYPE_OEM_PRI - OEM PRI file (file name strats with valid SKU such as “1104125_”) eFILE_TYPE_COMPO_PRI - A compound PRI files contain both Carrier PRI and OEM PRI

Enumerator
EFILE_TYPE_NONE 
EFILE_TYPE_CAR_PRI 
EFILE_TYPE_OEM_PRI 
EFILE_TYPE_COMPO_PRI 
enum eGobiDeviceSeries

enumeration which lists the Device Series

Enumerator
eGOBI_DEV_SERIES_UNKNOWN 
eGOBI_DEV_SERIES_NON_GOBI 
eGOBI_DEV_SERIES_G3K 
eGOBI_DEV_SERIES_SIERRA_GOBI 
eGOBI_DEV_SERIES_9X15 
eGOBI_DEV_SERIES_9X30 
eGOBI_DEV_SERIES_9X07_9X50 
eGOBI_DEV_SERIES_9X05 
eGobi_DEV_SERIES_MC83 
enum eGobiImageCarrier

enumeration which lists the carrier supported by the image

Enumerator
eGOBI_IMG_CAR_GENERIC 
eGOBI_IMG_CAR_FACTORY 
eGOBI_IMG_CAR_NORF 
eGOBI_IMG_CAR_VERIZON 
eGOBI_IMG_CAR_SPRINT 
eGOBI_IMG_CAR_ALLTEL 
eGOBI_IMG_CAR_BELL 
eGOBI_IMG_CAR_TELUS 
eGOBI_IMG_CAR_US 
eGOBI_IMG_CAR_TELSTRA1 
eGOBI_IMG_CAR_CHINA_UNICOM 
eGOBI_IMG_CAR_TELCOM_NZ 
eGOBI_IMG_CAR_SK_TELCOM1 
eGOBI_IMG_CAR_RELIANCE1 
eGOBI_IMG_CAR_TATA 
eGOBI_IMG_CAR_METROPCS 
eGOBI_IMG_CAR_LEAP 
eGOBI_IMG_CAR_KDDI 
eGOBI_IMG_CAR_IUSACELL 
eGOBI_IMG_CAR_CHINA_TELECOM 
eGOBI_IMG_CAR_OMH 
eGOBI_IMG_CAR_GENERIC_CDMA 
eGOBI_IMG_CAR_ATT 
eGOBI_IMG_CAR_VODAFONE 
eGOBI_IMG_CAR_TMOBILE 
eGOBI_IMG_CAR_ORANGE 
eGOBI_IMG_CAR_TELEFONICA 
eGOBI_IMG_CAR_TELCOM_ITALIA 
eGOBI_IMG_CAR_3 
eGOBI_IMG_CAR_O2 
eGOBI_IMG_CAR_SFR 
eGOBI_IMG_CAR_SWISSCOM 
eGOBI_IMG_CAR_CHINA_MOBILE 
eGOBI_IMG_CAR_TELSTRA2 
eGOBI_IMG_CAR_SINGTEL_OPTUS 
eGOBI_IMG_CAR_RELIANCE2 
eGOBI_IMG_CAR_BHARTI 
eGOBI_IMG_CAR_NTT_DOCOMO 
eGOBI_IMG_CAR_EMOBILE 
eGOBI_IMG_CAR_SOFTBANK 
eGOBI_IMG_CAR_KT_FREETEL 
eGOBI_IMG_CAR_SK_TELCOM2 
eGOBI_IMG_CAR_TELENOR 
eGOBI_IMG_CAR_NETCOM 
eGOBI_IMG_CAR_TELIASONERA 
eGOBI_IMG_CAR_AMX_TELCEL 
eGOBI_IMG_CAR_BRASIL_VIVO 
eGOBI_IMG_CAR_AERIS 
eGOBI_IMG_CAR_ROGERS 
enum eGobiImageGPS

enumeration which lists the GPS type supported by the image

Enumerator
eGOBI_IMG_GPS_NONE 
eGOBI_IMG_GPS_STAND_ALONE 
eGOBI_IMG_GPS_ASSISTED 
eGOBI_IMG_GPS_NO_XTRA 
enum eGobiImageRegion

enumeration which lists the region supported by the image

Enumerator
eGOBI_IMG_REG_NA 
eGOBI_IMG_REG_LA 
eGOBI_IMG_REG_EU 
eGOBI_IMG_REG_ASIA 
eGOBI_IMG_REG_AUS 
eGOBI_IMG_REG_GLOBAL 
enum eGobiImageTech

enumeration which lists the technology supported by the image

Enumerator
eGOBI_IMG_TECH_CDMA 
eGOBI_IMG_TECH_UMTS 
enum EImageType

Name: EImageType

Purpose: Enumerate some supported BC image types

Members: EIMAGE_TYPE_MIN - Start of list EIMAGE_TYPE_BOOT - boot composite image EIMAGE_TYPE_APPL - application composite image EIMAGE_TYPE_APPS - apps such as yocto image EIMAGE_TYPE_FILE - Generic file such as Carrier PRI EIMAGE_TYPE_SPKG - Sierra package, spk image, OEM PRI image EIMAGE_TYPE_MODM - modem composite image, modem firmware cwe image EIMAGE_TYPE_USER - image for 0:USERDATA, e.g. legato EIMAGE_TYPE_KEYS, - Keystore image, signed key information EIMAGE_TYPE_MAX - End of list EIMAGE_TYPE_INVALID - invalid image type EIMAGE_TYPE_ANY - any image type

Notes: none

Enumerator
EIMAGE_TYPE_MIN 
EIMAGE_TYPE_BOOT 
EIMAGE_TYPE_APPL 
EIMAGE_TYPE_APPS 
EIMAGE_TYPE_FILE 
EIMAGE_TYPE_SPKG 
EIMAGE_TYPE_MODM 
EIMAGE_TYPE_USER 
EIMAGE_TYPE_KEYS 
EIMAGE_TYPE_MAX 
EIMAGE_TYPE_INVALID 
EIMAGE_TYPE_ANY 

Function Documentation

ULONG DeleteStoredImage ( ULONG  imageInfoSize,
BYTE *  pImageInfo 
)

Used to delete the specified image from the device. This API function is only relevant to devices with the ability to store multiple firmware images(see Device Supported section below).

Parameters
imageInfoSize[IN]
  • The size in BYTEs of the image info array
pImageInfo[IN]
  • The image info list array containing information about the image to be deleted.
  • See ImageElement
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Device Supported: MC83x5/SL9090
Timeout: 2 Secs
ULONG DownloadToSlot ( CHAR *  path,
struct slqsfwinfo_s  fwImgInfo,
struct slqsfwinfo_s  priImgInfo,
BYTE  slot,
BYTE  forceDownload 
)

This API is dedicated for downloading a firmware image into a specific slot. it is used for MC7430/MC7455/EM7430/EM7455 only

Parameters
path
  • fully qualified path to firmware image to download
fwImgInfo
priImgInfo
slot
  • slot id in the modem to store the firmware
forceDownload
  • a flag to force download take place.
Returns
See qmerrno.h for eQCWWAN_xxx error values
Note
only EM7430/EM7455/MC7430/MC7455 is supported
void eGetDeviceSeries ( struct sGetDeviceSeriesResult *  )

Name : eGetDeviceSeries

Parameters
none
Returns
sGetDeviceSeriesResult
Note
Get Devie Series
ULONG GetImagesPreference ( ULONG *  pImageListSize,
struct PrefImageList *  pImageList 
)

restore original alignment from stack Gets the current images preference from the device.

Parameters
pImageListSize[IN/OUT]
  • Upon input, the size of structure ImageList ImageList
  • Upon successful output, the number of BYTEs copied to the image list array
pImageList[OUT]
  • The caller must supply a pointer to a ImageList structure typecast as a BYTE pointer
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG GetImageStore ( WORD  imageStorePathSize,
CHAR *  pImageStorePath 
)

Returns the image store folder, i.e., the folder containing one or more carrier-specific image subfolders compatible with the currently connected QC WWAN device.

Parameters
imageStorePathSize
  • Maximum number of characters (including NULL terminator) that can be copied to the image store path array.
pImageStorePath[OUT]
  • The path to the image store
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
ULONG GetStoredImages ( ULONG *  pImageListSize,
BYTE *  pImageList 
)

restore original alignment from stack Gets the list of images stored on the device.

Parameters
pImageListSize[IN/OUT]
  • Upon input, the size of structure ImageList ImageList
  • Upon successful output, the number of BYTEs copied to the image list array
pImageList[OUT]
  • The caller must supply a pointer to a ImageList structure typecast as a BYTE pointer
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Device Supported: MC83x5/SL9090
Timeout: 2 seconds
ULONG SetImagePath ( CHAR *  path,
ULONG  isMDM9x15,
WORD  imgMask,
BYTE  mdmProtocol 
)

This API is used to set image path for firmware download

Parameters
path[IN]
  • fully qualified path to firmware image to download.
isMDM9x15[IN]
  • a flag indicates whether it is a MDM9x15 device
imgMask[IN]
  • image mask to check CWE and NVU files are required or not
mdmProtocol[IN]
  • which firmware download protocol should be used
    • 0 - SSDP protocol
    • 1 - Firehose protocol
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 12 seconds
ULONG SetImagesPreference ( ULONG  imageListSize,
BYTE *  pImageList,
ULONG  bForceDownload,
BYTE  modemIndex,
ULONG *  pImageTypesSize,
BYTE *  pImageTypes 
)

Sets the current images preference on the device. After this function successfully completes, the device must be reset for the selected image preference to be realized. Additionally, when the returned list of image types that require downloading is not empty, the device opens in QDL mode after the reset. At that point, the QDL portion of this API must be used to download the selected image preference to the device.

Parameters
imageListSize
  • The size in BYTEs of the image list array
pImageList[IN]
  • The image info list array containing Image Elements
bForceDownload[IN]
  • Force device to download images from host? 0 - No Nonzero - Yes
modemIndex
  • Desired storage index for downloaded modem image (optional, a value of 0xFF indicates unspecified)
pImageTypesSize[IN/OUT]
  • Upon input, maximum number of elements that download image types array can contain
  • Upon successful output, number of elements in download image types array
pImageTypes[OUT]-The download image types array.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSDownloadFirmwareToSlot ( CHAR *  pPath,
BYTE  slot_index,
BYTE  force_download 
)

This API is used to download firmware to a specific slot id of the modem. It is only applicable for EM7430/EM7455 variant. This API encapsulates all steps involved in the firmware download process.Hence it is a blocking API call.
This API will not return until the entire process has been completed. This API will takes significant amount of time (in order of minutes, normally should be less than 10 minutes).

This API Performs the following steps:

  1. Verifies arguments.
  2. Retrieve and store the details of the firmware and the PRI file
  3. Enable device state change callback.
  4. Enable firmware download callback.
  5. Set Image preference on the device and reset the device.
  6. Wait for the firmware to download and device to become ready.
  7. Check the firmware update status. If fail, return an error.
  8. If update status is OK, check if current image preference and preferred image preference( from step 2 ) match
  9. If match, firmware download is successful. otherwise, report FW_PREFERENCE_MISMATCH
    10.Disable callbacks and exit.
    The call to this API blocks until step 7 or 10. This could be a significant amount of time ( in order of minutes ). Also note that the device state change callback and firmware download callback are used internally
    within this API. Hence the user application's instance of these callbacks (if any) are cleared. The user must re-enable these callbacks after a call to this API in order to use them.
    Parameters
    pPath[IN]
    • fully qualified path to firmware image to download.
    slot_index[IN]
    • slot id in the modem to store the firmware
    force_download[IN]
    • a flag to force download take place.
    Returns
    • eQCWWAN_ERR_NONE - Firmware download/Switch success.
    • eQCWWAN_ERR_INVALID_ARG - The path input does not contain any image
    • eQCWWAN_ERR_SWIIM_FW_UPDATE_FAIL - Firmware download/switch failed
    • eQCWWAN_ERR_SWIIM_FW_PREFERENCE_MISMATCH - Download success but device offline due to image preference mismatch ( ref. syslogs for cause )
    See Also
    See qmerrno.h for eQCWWAN_xxx error values
    Note
    Timeout: NA
ULONG SLQSGetBootVersionNumber ( ULONG *  bootversion)

Gets the boot loader version number

Parameters
bootversion[OUT]
  • boot loader version presented by a 4 byte integer
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Device Supported: MC9090/SL9090
Timeout: 2 seconds
ULONG SLQSGetFirmwareFileInfo ( CHAR *  pPath,
struct firmwarefileinfo_s *  pInfo,
BYTE *  pNumOfItems 
)

This API Get the firmware information of the provided image

Parameters
IN]pPath
  • file path or directory of the firmware image
OUT]pInfo
  • See firmwarefileinfo_s, application should allocate the memory
  • for the struct array, this API will fill in the details in the provided storage
OUT]pNumOfItems
Returns
enum eQCWWANError
ULONG SLQSGetFirmwareInfo ( struct qmifwinfo_s *  pinfo)

Returns firmware image information from the connected device

Parameters
pinfo[OUT]
  • firmware image information record
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
struct qmifwinfo_s
Note
Timeout: 2 Seconds.
ULONG SLQSGetImageInfo ( LPCSTR  path,
struct qmifwinfo_s *  pinfo 
)

Returns firmware image information from a CWE file or mbn files stored on the host. For CWE, information is returned for the first CWE image found at the specified path. For MBN, the provided path must be located under the image store for the currently connected QC WWAN device. Note that as this API supports multiple firmware image types, it relies on the presence of a supported device. Otherwise, refer to SLQSGetImageInfoMC83xx and SLQSGetImageInfoMC77xx for APIs which do not rely on the presence of a supported device.

Parameters
path[IN]
  • fully qualified path to folder containing CWE image or MBN images
  • should use a “/” at the end of the path.
pinfo[OUT]
  • firmware image information record
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
struct qmifwinfo_s
Note
Timeout: N/A
ULONG SLQSGetImageInfo_9x15 ( LPCSTR  path,
BYTE  imgType,
struct slqsfwinfo_s *  pinfo 
)

Returns firmware image information from a CWE file(s) stored on the host. It does not rely on the presence of a supported device.

Parameters
path[IN]
  • fully qualified path to folder containing the image(s)
  • should use a “/” at the end of the path.
imgType[IN]
  • 2 - Firmware Image( .cwe extension )
  • 3 - PRI Image ( .nvu extension )
pinfo[OUT]
  • firmware image information record
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
struct qmifwinfo_s
Note
Device Supported: MC73xx
Timeout: N/A
ULONG SLQSGetImageInfoMC77xx ( LPCSTR  path,
struct qmifwinfo_s *  pinfo 
)

Returns firmware image information from a SPKGS CWE file stored on the host. The information is returned for the first SPKGS CWE image found at the specified path. This API executes independent of a MC77xx being connected to the target.

Parameters
path[IN]
  • fully qualified path to folder containing SPKG CWE image
  • should use a “/” at the end of the path.
pinfo[OUT]
  • firmware image information record
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
struct qmifwinfo_s
Note
Device Supported: MC77xx
Timeout: N/A
ULONG SLQSGetImageInfoMC83xx ( LPCSTR  path,
struct qmifwinfo_s *  pinfo 
)

Returns firmware image information from an MBN file located on the host. This API executes independent of a MC83xx being connected to the target.

Parameters
path[IN]
  • fully qualified path to folder containing MBN file
  • should use a “/” at the end of the path.
pinfo[OUT]
  • firmware image information record
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
struct qmifwinfo_s
Note
Device Supported: MC83xx/SL9090
Timeout: N/A
ULONG SLQSGetImagePartNumber ( LPCSTR  path,
BYTE  imgType,
struct slqsfwpartno_s *  pinfo 
)

Returns firmware image part number by a well defined cwe spkg format firmware file

Parameters
path[IN]
  • fully qualified path to folder containing CWE image or MBN images
  • should use a “/” at the end of the path.
pinfo[OUT]
  • firmware image part number
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
struct slqsfwpartno_s
Note
Timeout: N/A
ULONG SLQSGetValidFwPriCombinations ( struct ImageList *  pStoredImageList,
ULONG *  pValidCombinationSize,
struct SWI_STRUCT_CarrierImage *  pValidCombinations 
)

This API distills valid Firmware/PRI combinations from GetStoredImages result

Parameters
[in]pStoredImageList
  • image list returned from GetStoredImages
[in,out]pValidCombinationSize
  • number of combination passed in and returned
[out]pValidCombinations
  • valid combinations returned
Returns
  • eQCWWAN_ERR_INVALID_ARG - Invalid parameters
  • eQCWWAN_ERR_BUFFER_SZ - No enough element to store combinatons returned
See Also
See qmerrno.h for eQCWWAN_xxx error values
int SLQSIsBootloaderDebugEnabled ( const char *  szPath,
const char *  pQsn 
)

This API is used to check if the bootloader is debug enabled or not for the specified QSN

Parameters
szPath[IN]
  • the full path of the provided bootloader or firmware file
pQsn[IN]
  • the QSN of a specific module user wants to check, it is a 4 bytes hex value without the prefix 0X. It can be retrieved by AT command AT!ENTERCND=“<password>”, AT!SECBOOTCFG?, the first parameter of the response of AT!SECBOOTCFG?.
Returns
values listed below
  • -1 bootloader is not debug enabled
  • 0 unbale to retrieve the bootloader debug info
  • 1 bootloader is debug enabled for the provided QSN
  • 4 either szPath or pQsn is invalid (NULL)
  • 18 invalid file
BOOL SLQSIsSpkgFormatRequired ( void  )

Check if SPKG format download is required for SL9090/MC9090, it returns the value whcih was set by API SLQSSetSpkgFormatRequired()

Parameters
none
Returns
return TRUE if required, otherwise, return FALSE
Note
Device Supported: MC9090/SL9090
void SLQSSetCrashStateCheckIgnore ( BOOL  ignore)

This API is used to set whether ignore crash state checking before proceed firmware download using the API UpgradeFirmware2k().

Parameters
[in]ignore
  • 0 - crash state checking applied (default value)
  • 1 - ignore crash state checking
Note
Device Supported: EM73xx/MC73xx, EM7430/EM7455/MC7430/MC7455
ULONG SLQSSetSIMBasedImageSwitching ( void  )

This API is used to enable the SIM-based Image Switching. The modem will reboot automatically to take effect of the enabing

Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Device Supported: EM7430/EM7455/MC7430/MC7455
void SLQSSetSpkgFormatRequired ( BYTE  isneeded)

Set if SPKG format download is required for SL9090/MC9090

Parameters
isneeded[INPUT] user inputs the firmware download method preference
  • 1 - Gobi3K download method, use mbn files. This is default value
  • 2 - SPKG download method, use cwe file
Returns
None
Note
Device Supported: MC9090/SL9090
ULONG SLQSSwiGetAllCarrierImages ( ULONG *  pNumOfItems,
struct SWI_STRUCT_CarrierImage *  pCarrierImages,
char *  pFolderPath 
)

This API gets a list of all images stored on both the host and the device

Parameters
pNumOfItems
  • Number of Images{IN/OUT]
pCarrierImages[OUT]
pFolderPath
  • Path of Input folder [IN]
Returns
TRUE/FALSE
Note
In case pFolderPath is invalid, API does not return invalid path error as SLQSSwiGetAllCarrierImages get carrier images from device also.
ULONG SLQSSwiGetFirmwareCurr ( CurrentImgList *  pCurrentImgList)

This API gets the currently active images on the device.

Parameters
pCurrentImgList
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Technology Supported: NA
Device Supported: MC73xx, EM7430/EM7455/MC7430/MC7455
Timeout: 5 Secs
ULONG SLQSUpgradeFirmware9x07 ( CHAR *  pDestinationPath)

This API is used to download firmware to a WP760x device.

This API Performs the following steps:

  1. Verifies arguments.
  2. Informs the SDK of the firmware upgrade path
  3. Send the DM command to requests the device reset (device will reset after all open handles are released).
    Upon successful completion, the above steps will have been completed, however, the actual upgrade of the firmware will necessarily then follow.
Parameters
pDestinationPath[IN]
  • fully qualified path to firmware image to download.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 5 seconds
ULONG SLQSUpgradeFirmware9x15 ( CHAR *  pDestinationPath)

This API is used to upgrade firmware on a MC73xx device. This API encapsulates all steps involved in the firmware download process. It is an alternative to any firmware download application. Hence it is a blocking API call. This API will not return until the entire process has been completed.

This API Performs the following steps:

  1. Verifies arguments.
  2. Retrieve and store the details of the firmware and the PRI file
  3. Enable device state change callback.
  4. Enable firmware download callback.
  5. Set Image preference on the device and reset the device.
  6. Wait for the firmware to download and device to become ready.
  7. Check the firmware update status. If fail, return an error.
  8. If update status is OK, check if current image preference and preferred image preference( from step 2 ) match
  9. If match, firmware download is successful.
  10. If do not match, repeat from step 5 once more.
  11. Disable callbacks and exit.
    The call to this API blocks until step 7 or 11. This could be a significant amount of time ( in order of minutes ). Also note that the device state change callback and firmware download callback are used internally
    within this API. Hence the user application's instance of these callbacks (if any) are cleared. The user must re-enable these callbacks after a call to this API in order to use them.
    Parameters
    pDestinationPath[IN]
    • fully qualified path to firmware image to download. The path must
      end with a forward slash.
    Returns
    • eQCWWAN_ERR_NONE - Firmware download/Switch success.
    • eQCWWAN_ERR_INVALID_ARG - The path input does not contain any image
    • eQCWWAN_ERR_SWIIM_FW_UPDATE_FAIL - Firmware download/switch failed
    • eQCWWAN_ERR_SWIIM_FW_PREFERENCE_MISMATCH - Download success but device offline due to image preference mismatch ( ref. syslogs for cause )
    See Also
    See qmerrno.h for eQCWWAN_xxx error values
    Note
    Timeout: NA
ULONG upgrade_9x07_9x50_fw ( LPCSTR  path)

This API is used to download firmware to a 9x07 or 9x50 device.

Parameters
pDestinationPath[IN]
  • fully qualified path to firmware image to download.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 12 seconds
ULONG upgrade_mc77xx_fw ( LPCSTR  path)
ULONG UpgradeFirmware2k ( CHAR *  pDestinationPath)

This API is used to download firmware to a MC77xx or Gobi 3000 device. For SL909/MC9090, SLQSSetSpkgFormatRequired() needs to be called in advance to specify the download method, Gobi3K or SPKG download, please refer to the API SLQSSetSpkgFormatRequired() for more details of the input values. If SLQSSetSpkgFormatRequired() is not called in advance, it will us Gobi3K firmware download method (MBN files) as the default download method.

This API Performs the following steps:

  1. Verifies arguments.
  2. Verify that device Crash State should be 1 (RESET State).
  3. Informs the SDK of the firmware upgrade path
  4. Updates the images preference on the currently connected device.
  5. Requests the device reset (device will reset after all open handles are released).
    Upon successful completion, the above steps will have been completed, however, the actual upgrade of the firmware will necessarily then follow.
Parameters
pDestinationPath[IN]
  • fully qualified path to firmware image to download. The path must
    end with a forward slash. For a Gobi 3000 device the path should
    specify the carrier image folder index i.e.
    “<path/<carrier index>/” where <carrier index>
    is a valid sub-directory entry. For 9x30 devices if pDestinationPath
    is not valid on host, it will use pseudo path for image switching.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 12 seconds
Copyright (c) 2011-2015 Sierra Wireless, Inc. All rights reserved